<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>IgH EtherCAT Master: ethernet.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">IgH EtherCAT Master
   &#160;<span id="projectnumber">1.5.2</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('ethernet_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ethernet.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Ethernet over EtherCAT (EoE)  
<a href="#details">More...</a></p>

<p><a href="ethernet_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__eoe__frame__t.html">ec_eoe_frame_t</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queued frame structure.  <a href="structec__eoe__frame__t.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structec__eoe.html">ec_eoe</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ethernet over EtherCAT (EoE) handler.  <a href="structec__eoe.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a03b01351f25a9210938e676941427cf4"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structec__eoe.html">ec_eoe</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a></td></tr>
<tr class="separator:a03b01351f25a9210938e676941427cf4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a890ed81aeeee6742971bae174623f7d9"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#a890ed81aeeee6742971bae174623f7d9">ec_eoe_init</a> (<a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *, <a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *)</td></tr>
<tr class="memdesc:a890ed81aeeee6742971bae174623f7d9"><td class="mdescLeft">&#160;</td><td class="mdescRight">EoE constructor.  <a href="#a890ed81aeeee6742971bae174623f7d9">More...</a><br /></td></tr>
<tr class="separator:a890ed81aeeee6742971bae174623f7d9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d848439972cb4dcc037a2f9bb456715"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#a2d848439972cb4dcc037a2f9bb456715">ec_eoe_clear</a> (<a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *)</td></tr>
<tr class="memdesc:a2d848439972cb4dcc037a2f9bb456715"><td class="mdescLeft">&#160;</td><td class="mdescRight">EoE destructor.  <a href="#a2d848439972cb4dcc037a2f9bb456715">More...</a><br /></td></tr>
<tr class="separator:a2d848439972cb4dcc037a2f9bb456715"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab7ba009185c67570f4c95446cee7eb76"><td class="memItemLeft" align="right" valign="top"><a id="ab7ba009185c67570f4c95446cee7eb76"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#ab7ba009185c67570f4c95446cee7eb76">ec_eoe_run</a> (<a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *)</td></tr>
<tr class="memdesc:ab7ba009185c67570f4c95446cee7eb76"><td class="mdescLeft">&#160;</td><td class="mdescRight">Runs the EoE state machine. <br /></td></tr>
<tr class="separator:ab7ba009185c67570f4c95446cee7eb76"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a18fc60e72cbbc99eb59a0e43abdfe328"><td class="memItemLeft" align="right" valign="top"><a id="a18fc60e72cbbc99eb59a0e43abdfe328"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#a18fc60e72cbbc99eb59a0e43abdfe328">ec_eoe_queue</a> (<a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *)</td></tr>
<tr class="memdesc:a18fc60e72cbbc99eb59a0e43abdfe328"><td class="mdescLeft">&#160;</td><td class="mdescRight">Queues the datagram, if necessary. <br /></td></tr>
<tr class="separator:a18fc60e72cbbc99eb59a0e43abdfe328"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aac0563934b958ac04dc433e8fe442234"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#aac0563934b958ac04dc433e8fe442234">ec_eoe_is_open</a> (const <a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *)</td></tr>
<tr class="memdesc:aac0563934b958ac04dc433e8fe442234"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the state of the device.  <a href="#aac0563934b958ac04dc433e8fe442234">More...</a><br /></td></tr>
<tr class="separator:aac0563934b958ac04dc433e8fe442234"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c002900d42f291213e271b7196f991e"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ethernet_8h.html#a2c002900d42f291213e271b7196f991e">ec_eoe_is_idle</a> (const <a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *)</td></tr>
<tr class="memdesc:a2c002900d42f291213e271b7196f991e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the idle state.  <a href="#a2c002900d42f291213e271b7196f991e">More...</a><br /></td></tr>
<tr class="separator:a2c002900d42f291213e271b7196f991e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Ethernet over EtherCAT (EoE) </p>

<p class="definition">Definition in file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a id="a03b01351f25a9210938e676941427cf4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a03b01351f25a9210938e676941427cf4">&#9670;&nbsp;</a></span>ec_eoe_t</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef struct <a class="el" href="structec__eoe.html">ec_eoe</a> <a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a></td>
        </tr>
      </table>
</div><div class="memdoc">
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structec__eoe.html" title="Ethernet over EtherCAT (EoE) handler. ">ec_eoe</a> </dd></dl>

<p class="definition">Definition at line <a class="el" href="ethernet_8h_source.html#l00068">68</a> of file <a class="el" href="ethernet_8h_source.html">ethernet.h</a>.</p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a890ed81aeeee6742971bae174623f7d9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a890ed81aeeee6742971bae174623f7d9">&#9670;&nbsp;</a></span>ec_eoe_init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_eoe_init </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *&#160;</td>
          <td class="paramname"><em>eoe</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="globals_8h.html#a8d9ffff7dbe1babaa4786a63f2860d57">ec_slave_t</a> *&#160;</td>
          <td class="paramname"><em>slave</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>EoE constructor. </p>
<p>Initializes the EoE handler, creates a net_device and registers it.</p>
<dl class="section return"><dt>Returns</dt><dd>Zero on success, otherwise a negative error code. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eoe</td><td>EoE handler </td></tr>
    <tr><td class="paramname">slave</td><td>EtherCAT slave </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ethernet_8c_source.html#l00104">104</a> of file <a class="el" href="ethernet_8c_source.html">ethernet.c</a>.</p>

</div>
</div>
<a id="a2d848439972cb4dcc037a2f9bb456715"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d848439972cb4dcc037a2f9bb456715">&#9670;&nbsp;</a></span>ec_eoe_clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ec_eoe_clear </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *&#160;</td>
          <td class="paramname"><em>eoe</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>EoE destructor. </p>
<p>Unregisteres the net_device and frees allocated memory. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eoe</td><td>EoE handler </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ethernet_8c_source.html#l00208">208</a> of file <a class="el" href="ethernet_8c_source.html">ethernet.c</a>.</p>

</div>
</div>
<a id="aac0563934b958ac04dc433e8fe442234"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aac0563934b958ac04dc433e8fe442234">&#9670;&nbsp;</a></span>ec_eoe_is_open()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_eoe_is_open </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *&#160;</td>
          <td class="paramname"><em>eoe</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the state of the device. </p>
<dl class="section return"><dt>Returns</dt><dd>1 if the device is "up", 0 if it is "down" </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eoe</td><td>EoE handler </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ethernet_8c_source.html#l00366">366</a> of file <a class="el" href="ethernet_8c_source.html">ethernet.c</a>.</p>

</div>
</div>
<a id="a2c002900d42f291213e271b7196f991e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c002900d42f291213e271b7196f991e">&#9670;&nbsp;</a></span>ec_eoe_is_idle()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int ec_eoe_is_idle </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="ethernet_8h.html#a03b01351f25a9210938e676941427cf4">ec_eoe_t</a> *&#160;</td>
          <td class="paramname"><em>eoe</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Returns the idle state. </p>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">1</td><td>The device is idle. </td></tr>
    <tr><td class="paramname">0</td><td>The device is busy. </td></tr>
  </table>
  </dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">eoe</td><td>EoE handler </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ethernet_8c_source.html#l00378">378</a> of file <a class="el" href="ethernet_8c_source.html">ethernet.c</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_c1346cf4828efdd0d2baf0d391d01b77.html">master</a></li><li class="navelem"><a class="el" href="ethernet_8h.html">ethernet.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
